tests: added test for Body() methods of requests using golden files #450
Conversation
bigbes
force-pushed
the
bigbes/TNTP-3334-iproto-body-tests
branch
2 times, most recently
from
5977e48 to
8897eb5
Compare
bigbes
force-pushed
the
bigbes/TNTP-3334-iproto-body-tests
branch
2 times, most recently
from
55de81c to
fe36442
Compare
| // ``` | ||
| // Use it to debug the test. | ||
| // | ||
| // If you want to update the golden file, run delete old file and rerun the test. |
There was a problem hiding this comment.
It's up to you, but I think it would be more reasonable to explicitly create data files with the update-testdata flag or something similar.
Otherwise, the absence of a control file will result in the test passing successfully.
As for an example, you could check: https://github.com/tarantool/tt/blob/master/cli/tcm/log_test.go#L23
There was a problem hiding this comment.
I agree. Ideally we need to separate generation of data from tests and generate it with go generate. But a flag a good idea too.
golden_test.go
Outdated
| BitwiseOr(8, 11). | ||
| BitwiseXor(9, 12) | ||
|
|
||
| for _, tc := range []goldenTestCase{ |
There was a problem hiding this comment.
It would probably be better to separate the initialisation of test cases and the logic of the test loop.
There was a problem hiding this comment.
Thanks! Could you please verify if this change matches what you had in mind?
There was a problem hiding this comment.
I meant a more classic solution with a separate variable for cases and a simple loop, without creating and initialising a complex multi-line structure:
| for _, tc := range []goldenTestCase{ | |
| testCases := []goldenTestCase{ | |
| ... | |
| } | |
| for _, tc := range testCases{ |
| // | ||
| // If you want to update the golden file, run delete old file and rerun the test. | ||
|
|
||
| func logMsgpackAsJsonConvert(t *testing.T, data []byte) { |
There was a problem hiding this comment.
| func logMsgpackAsJsonConvert(t *testing.T, data []byte) { | |
| func logMsgpackAsJsonConvert(t *testing.T, data []byte) { | |
| t.Helper() |
Helper function?
bigbes
force-pushed
the
bigbes/TNTP-3334-iproto-body-tests
branch
from
fe36442 to
ca0c7f6
Compare
| err := req.Body(&dummySchemaResolver{}, encoder) | ||
| require.NoError(t, err, "failed to encode request") | ||
|
|
||
| goldenFileExists := fileExists(name) |
There was a problem hiding this comment.
I don't quite understand why it is necessary to check for the existence of a file here.
- If we generate new ones, we simply overwrite them, regardless of whether the old ones exist. But it's still better to automatically delete all the old ones before running the tests so that no rubbish is saved if there have been any changes to the tests.
- If there is no file for the test, there will be an error when trying to read it anyway.
There was a problem hiding this comment.
That's something that I want to avoid:
- The Tarantool protocol is unlikely to change, so the behavior of those tests won't need frequent updates. New tests will be added, but existing tests should mostly remain unchanged.
- If a test is modified, I don’t want to require rewriting all tests — this could eventually introduce bugs due to human error (e.g., accidentally committing test data without proper review). Instead, I want the user to remove only the test cases affected by their change, after carefully considering potential mistakes.
bigbes
force-pushed
the
bigbes/TNTP-3334-iproto-body-tests
branch
from
ca0c7f6 to
babd1e3
Compare
This pull request introduces changes to the test data files for various request types.